To make a lock request, add a lock event using the addLockEvent call. This section covers the simplest case of an addLockEvent call.

For the following more complex event requests, refer to their relevant pages:

• Add a price concession, then create a lock request including that concession. See Lock Request w/ Price Concession.
• Deny a lock request that has been placed on a loan. See Deny Lock Request.
• Approve a lock request that has been placed on a loan. See Approve Lock Request.
• Alter the price of a loan. See Reprice.
• Extend the lock period for a loan. See Extension Request.
• Approve an extension request that has been made for a lock. See Approve Extension.
• Apply a discount or similar concession to the loan. See Request Post-Lock Price Concession.
• Remove a lock on a loan. See Cancel Lock.

Path

/rest/v1/lp-ppe-api/price-quote/addLockEvent

Headers

Path Parameters

There are no path parameters

Body

Pass the following IDs, along with a scenario lock, any exception or extension data if applicable, the date, and a comment:

{
    lockId: ObjectId;
    lockStatusId: ObjectId;
    priceQuoteId: ObjectId;
    lockEventExceptionInfo: LockEventExceptionInfo;
    lockEventExtensionInfo: LockEventExtensionInfo;
    scenario: ScenarioLock;
    lockDateUpdate: Date;
    lockEventComment: String;
}

 Example Request

curl --location -g --request POST '{{protocol}}{{domain}}/rest/v1/lock/addLockEvent' \
--header 'secret: {{token}}' \
--header 'companyid: {{companyId}}' \
--data-raw '{
    "lockId": "{{lockId}}",
    "lockStatusId": "{{lockStatusId}}",
    "priceQuoteId": "{{priceQuoteId}}",
    "lockEventExceptionInfo": null,
    "lockEventExtensionInfo": null
}'

Response

 The response returns the lock data and any modification data.